/*
 * Copyright 2012 Faculty of Informatics - Masaryk University.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package cz.muni.fi.pa165.creatures.dao;

import cz.muni.fi.pa165.creatures.model.Weapon;
import java.util.List;

/**
 * This interface represents a contract for implementation of the DAO for 
 * the {@link cz.muni.fi.pa165.creatures.model.Weapon} entity.
 * 
 * @author Tomas Hajek
 */
public interface WeaponDAO {
    
    /**
     * Create a new weapon.
     * 
     * @param weapon the weapon to be created
     * @throws IllegalArgumentException if {@code weapon} is null
     */
    public void create(Weapon weapon) throws IllegalArgumentException;
    
    /**
     * Update existing weapon.
     * 
     * @param weapon the weapon to be updated
     * @throws IllegalArgumentException if {@code weapon} is null
     */
    public void update(Weapon weapon) throws IllegalArgumentException;
    
    /**
     * Remove existing weapon.
     * 
     * @param weapon the weapon to be removed
     * @throws IllegalArgumentException if {@code weapon} is null
     */
    public void remove(Weapon weapon) throws IllegalArgumentException;
    
    /**
     *  Get a weapon by its id.
     * 
     * @param id 
     * @return the weapon with the given {@code id} or null if the weapon 
     * doesn't exist
     */
    public Weapon get(Long id);
    
    /**
     * Get count of all weapons.
     * 
     * @return number of all weapons
     */
    public int getCount();
    
    /**
     * Get all weapons.
     * 
     * @return list of all weapons
     */
    public List<Weapon> getAll();    
}
